home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / rtfdc100.zip / RTFDC.DOC < prev    next >
Text File  |  1992-08-14  |  16KB  |  515 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                RBBS Turbo FMS Dupe Checker  Version 1.00 (RTFDC)
  20.             Copyright 1992 by Walter C. Ames.  All rights reserved.
  21.                              Created July 5, 1992
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28. ╓───────────────────────────────────────────────────────────────────────╖
  29. ║                            TABLE OF CONTENTS                          ║
  30. ╙───────────────────────────────────────────────────────────────────────╜
  31.  
  32.  
  33.  
  34.  
  35. License/Warranty/Registration . . . . . . . . . . . . . . . . . . . . 1
  36.   License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  37.   Warranty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  38.   Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  39.  
  40.  
  41. Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  42.   About RTFDC . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  43.   RTFDC Features. . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  44.   Kudos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  45.  
  46.  
  47. Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  48.   System Requirements . . . . . . . . . . . . . . . . . . . . . . . . 3
  49.  
  50.  
  51. Command Line Syntax/Usage . . . . . . . . . . . . . . . . . . . . . . 3
  52.  
  53.  
  54. Creating Your Configuration File. . . . . . . . . . . . . . . . . . . 4
  55.  
  56.  
  57. RTFDC Report File . . . . . . . . . . . . . . . . . . . . . . . . . . 7
  58.  
  59. Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
  60.   Problem Reporting . . . . . . . . . . . . . . . . . . . . . . . . . 8
  61.  
  62. ╓───────────────────────────────────────────────────────────────────────╖
  63. ║                    LICENSE - WARRANTY - REGISTRATION                  ║
  64. ╙───────────────────────────────────────────────────────────────────────╜
  65.  
  66. Distribution and/or use is permitted under the following terms:
  67.  
  68. You may copy and distribute verbatim copies of the RTFDC documentation
  69. and executable code as you receive it, in any medium, provided that you
  70. conspicuously and appropriately publish on each copy a valid copyright
  71. notice "Copyright 1992 by Walter C. Ames"; keep intact the notices on all
  72. files that refer to this license agreement and to the absence of any
  73. warranty.  PROVIDE UNMODIFIED COPIES OF THE DOCUMENTATION AS PROVIDED
  74. WITH THE PROGRAM; and give any of the other recipients of the RTFDC
  75. program a copy of this license agreement along with the program.  You may
  76. charge a distribution fee for the physical act of transferring a copy,
  77. but no more than is necessary to recover your actual costs incurred in
  78. the transfer. Under no circumstances is RTFDC to be distributed in such a
  79. way as to be construed as "value added" in a sales transaction, such as,
  80. but not limited to, software bundled with a modem or CD-ROM software
  81. collections, without the prior written consent of the author.
  82.  
  83.                                  Warranty
  84.  
  85. THIS PRODUCT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, INCLUDING
  86. ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  THE
  87. ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THIS PROGRAM IS ASSUMED
  88. BY YOU. FURTHERMORE, I THE AUTHOR DO NOT WARRANT, GUARANTEE, OR MAKE ANY
  89. REPRESENTATIONS REGARDING THE USE OF OR THE RESULTS OF THE USE OF THE
  90. PROGRAM, OR THAT THE PROGRAM WILL RUN WITHOUT ERROR, AND YOU RELY ON THE
  91. PROGRAM AND RESULTS SOLELY AT YOUR OWN RISK.  I THE AUTHOR CANNOT ACCEPT
  92. RESPONSIBILITY FOR SYSTEM DAMAGE, LOSS OF PROFIT, OR ANY OTHER SPECIAL,
  93. INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM THE USE OR INABILITY
  94. TO USE THIS PRODUCT.
  95.  
  96.                                Registration
  97.  
  98. This program is being released under the "FREEWARE" concept.  This means
  99. that the program is "JUST FREE" no strings attached.  You may use it for
  100. as long as you like or delete it right away.  If you enjoy the program
  101. and feel that you must do something then please consider donating to
  102. the charity of your choice.  I'm just one for good causes :-)  By no
  103. means is the above mandatory simply a suggestion.
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.                                     -1-
  119. ╓───────────────────────────────────────────────────────────────────────╖
  120. ║                              INTRODUCTION                             ║
  121. ╙───────────────────────────────────────────────────────────────────────╜
  122.  
  123.  
  124.                                 About RTFDC
  125.  
  126. RTFDC is a full featured RBBS File Management System Duplicate Checker.
  127. When set-up properly and used regularly it can aid in maintaining your
  128. RBBS File Management System.  RTFDC has the ability to generate reports
  129. based on several different FMS conditions and is completely configurable.
  130.  
  131.  
  132.  
  133.                              RTFDC's Features
  134.  
  135.    o  Complete configurability.
  136.    o  Works with any size FMS.
  137.    o  Works with Chained FMS directories.
  138.    o  Creates formated reports based on runtime requests.
  139.    o  Creates a list of all duplicate FMS entries.
  140.    o  Creates a list of all duplicate entries on disk.
  141.    o  Creates a list of all files in the FMS but not on the Disk(s).
  142.    o  Creates a list of all files on the Disk(s) but not in the FMS.
  143.    o  Four levels of processing.
  144.    o  User definable Sorting utility.
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.                                     -2-
  176. ╓───────────────────────────────────────────────────────────────────────╖
  177. ║                                  Kudos                                ║
  178. ╙───────────────────────────────────────────────────────────────────────╜
  179.  
  180. I would like to take this opportunity to give special thanks to those
  181. individuals who contributed to the development of RTFDC.  Their names are
  182. listed alphabetically below.
  183.  
  184. Tom Collins            MSFA                        (410)536-1935
  185. Dan Shore              The ShoreLine BBS           (301)946-2771
  186. Larry Tyler            Games & Graphics            (301)672-5360
  187.  
  188.  
  189. ╓───────────────────────────────────────────────────────────────────────╖
  190. ║                         INSTALLATION PROCEDURES                       ║
  191. ╙───────────────────────────────────────────────────────────────────────╜
  192.  
  193.                                Assumptions
  194.  
  195. Three basic assumption are made:
  196.  
  197.   1)   You are an RBBS-PC SysOp with an operational RBBS installation.
  198.   2)   You are familiar with the operation of DOS and RBBS.
  199.   3)   You would like to test your File database for duplicates.
  200.  
  201.                             System Requirements
  202.  
  203. Although RTFDC was designed to be as generic as possible, the following
  204. system configuration is required as a minimum:
  205.  
  206.   1)   An IBM PC, XT, AT, PS/2, or a 100% compatible.
  207.   2)   MS/PC-DOS 3.1 or above.
  208.   3)   A text file sorting utility such as QSort or Sortf.  Any sorting
  209.        utility that is capable of sorting a text file the size of your FMS  
  210.        and accepts the command line parameters <infile> <outfile> should    
  211.        work.  The DOS sort program will NOT work with RTFDC.
  212.  
  213.                            Installation Summary
  214.  
  215.   1)   Read the documentation to become familiar with options.
  216.   3)   Determine the configuration options to be used.
  217.   4)   Edit the parameters in the sample configuration file to reflect
  218.        your systems needs or create a new configuration file.
  219.   5)   Run RTFDC.
  220.  
  221. ╓───────────────────────────────────────────────────────────────────────╖
  222. ║                        COMMAND LINE SYNTAX/USAGE                      ║
  223. ╙───────────────────────────────────────────────────────────────────────╜
  224.  
  225. The general format for RTFDC is:
  226.  
  227.      RTFDC [CfgFile] [switches]
  228.  
  229.    switches:
  230.       /?  Help
  231.  
  232.                                     -3-
  233. ╓───────────────────────────────────────────────────────────────────────╖
  234. ║                    CREATING YOUR CONFIGURATION FILE                   ║
  235. ╙───────────────────────────────────────────────────────────────────────╜
  236.  
  237. The RTFDC configuration file is merely an ASCII text file.  It uses a 
  238. series of Keywords that define the parameters and file paths you wish to 
  239. use.  The Keywords can be placed in any order and in any case.  The 
  240. Keywords must begin in column 1 of the line they reside on to be 
  241. effective, otherwise they are ignored as comments.  Any line beginning 
  242. with a semi-colon or a space is considered a comment.  Blank lines are 
  243. also ignored.
  244.  
  245. The Following is a list of Valid Keywords:
  246.  
  247.   Mandatory Keywords:  These are keywords that must be included in an       
  248.     RTFDC configuration file.  If any of the following keywords are         
  249.     omitted RTFDC will terminate with in an error condition.
  250.  
  251.   FMS_Directory   - Full Path and FileName to the FMS Directory.
  252.   FIDX_Def        - Full Path and FileName to the FIDX.DEF File.
  253.   LIDX_Def        - Full Path and FileName to the LIDX.DEF File.
  254.   Sort_Prog       - Full Path and FileName to the Sorting Util.
  255.  
  256. 1.  FMS_Directory    (Max - 20)
  257.  
  258.     The 'FMS_Directory' Keyword is used to define the full name and  path
  259.     of the  FMS directory to be processed.  If "Chained" type directories
  260.     are being used RTFDC will process all Chains.  RTFDC will process  up
  261.     to 20 FMS Directories.  This includes "Chains".  Each FMS directory     
  262.     you wish to process must have it's own keyword.
  263.  
  264.     Ex. FMS_Directory   C:\Rbbs\Dirr\Master.Dir
  265.  
  266.  
  267. 2.  Fidx_Def         (Max - 01)
  268.  
  269.     The 'Fidx_Def' Keyword is used to  define the full  name and path to
  270.     the FIDX.DEF File you wish to process.  This file must be related to
  271.     the FMS directory to be processed or the dupe list may be very long.
  272.     If you are not using the Fast File Search feature of RBBS and do not
  273.     have less than 20 D/L directories to process this program will be of
  274.     no use to you as it was designed to work with the FFS System.
  275.  
  276.     Ex. Fidx_Def        C:\Rbbs\Dirr\Fidx.Def
  277.  
  278.  
  279. 3.  Lidx_Def         (Max - 01)
  280.  
  281.     The 'Lidx_Def' Keyword is used to  define the full  name and path to
  282.     the corresponding LIDX.DEF File.  This will be used in the reporting
  283.     process to give you the exact locations of duplicate files.
  284.  
  285.     Ex. Lidx_Def        C:\Rbbs\Dirr\Lidx.Def
  286.  
  287.  
  288.  
  289.                                     -4-
  290. 4.  Sort_Prog        (Max - 01)
  291.  
  292.     The 'Sort_Prog' Keyword is used to  define the full name and path to
  293.     the sorting program you wish to have RTFDC use to do it's sorting.
  294.     RTFDC doesn't do it's own sorting!  The Sort program you choose must
  295.     take the following command line arguments:  ProgName <source> <dest>
  296.     The Sort programs that have been tested are: Qsort.Exe and Sortf.Com
  297.     If Qsort is used Version 3.04 or higher is required. If Sorf is used
  298.     Version 2.57 or higher is required. The sorting program bundled with
  299.     DOS will not work with RTFDC.  Other versions of the above mentioned
  300.     sort programs may work, but the above mention versions were tested.
  301.  
  302.     Ex. Sort_Prog       C:\Work\qsort.exe
  303.  
  304.  
  305.   Optional Keywords:   These are keywords that are designed to enhance the  
  306.     operation of RTFDC and are considered optional.  The absence of any of  
  307.     these keywords will not affect the operation of RTFDC in the least.
  308.  
  309.   Proc_Level      - Selects the level of Processing and Reporting.
  310.   Priv_Dir        - Full Path and FileName to the Private Directory.
  311.   Extra_Dir       - Directories not processed by the MakeFidx program.
  312.   Exclude_Dir     - Directories to be excluded from the reporting Process.
  313.   Ver_Comp        - Not available in this version.
  314.  
  315.  
  316. 1. Proc_Level       (1,2,3,4)  Default = 4
  317.  
  318.    The 'Proc_Level' Keyword is used to define the level of processing to
  319.    be performed by RTFDC.  Each level will perform the  function of that
  320.    level and ALL levels under it.   ie.  If Level 2 processing is chosen
  321.    Level 1 and 2 processing will be performed.  If Level 3 processing is
  322.    chosen Levels 1, 2, and 3 processing will be performed.
  323.  
  324.    1.  Create a List of any Duplicate entries in the FMS Directory(s).
  325.    2.  Create a List of any Duplicate Files on your Disk(s).
  326.    3.  Create a List of Files in your FMS but not on your Disk(s).
  327.    4.  Create a List of Files on your Disk(s) but not in your FMS.
  328.  
  329.    Ex. Proc_Level 4
  330.  
  331.  
  332. 2. Priv_Dir         (Max - 01)
  333.  
  334.    The 'Priv_Dir' Keyword is used to define the full  name and  path to
  335.    you RBBS "Private Directory."  This will be used to locate duplicate
  336.    entries in the  corresponding FMS  directories to be  processed.  It
  337.    will also determine if any files listed in the Private directory are
  338.    not located on a specified D/L drive.
  339.  
  340.    Ex. Priv_dir        C:\Rbbs\Priv\Priv.Def
  341.  
  342.  
  343.  
  344.                                     -5-
  345. 3. Extra_Dir        (Max - 20)
  346.  
  347.    The 'Extra_Dir' Keyword is used to  define up  to a Max of 20  other
  348.    directories to process.  These will be directories not listed in the
  349.    FIDX.DEF File, or if you  are not  using the FFS and wish to process
  350.    only 20 directories. Each Directory must have it's own keyword or it
  351.    will not be processed.  A File Mask is required for this keyword.
  352.    ie. If you want all .ZIP files to be processed ONLY use *.ZIP
  353.        If you want ALL Files to be processed use *.*
  354.  
  355.    Ex. Extra_Dir       E:\Rbbs\Upld\*.*
  356.  
  357.  
  358. 4. Exclude_Dir      (Max - 05)
  359.  
  360.    The 'Exclude_Dir' Keyword is used to define any disk directory that
  361.    you wish to Exclude from the duplicate reporting process.  This can
  362.    be useful if you have a directory full of Zero  byte files used to
  363.    stop people from uploading specific files.  You would not want said
  364.    directories included in the reporting process.  Use this Keyword to
  365.    avoid unnecessary reporting.
  366.  
  367.    Ex. Exclude_Dir     P:\DUPES\1\
  368.  
  369. 5. Ver_Comp         (Yes / No) Default = No
  370.  
  371.    Future feature.  Look for it in next version.
  372.  
  373.    Ex. Ver_Comp        Yes
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.                                     -6-
  402. ╓──────────────────────────────────────────────────────────────────────╖
  403. ║                           THE REPORT FILE                            ║
  404. ╙──────────────────────────────────────────────────────────────────────╜
  405.  
  406. The following is an example of RTFDC's Output Report File.
  407.  
  408.  
  409.  
  410. List of Files Found on the Disk(s) but NOT Found in the FMS
  411.  
  412. [ FileName ]---[ Directory ]--------------------------------------------
  413. $4SCHOOL.ZIP   G:\FILES\1\
  414. 4SQ11.ZIP      G:\FILES\6\
  415. ADULT.ZIP      E:\RBBS\DNLD\
  416. ARC600.EXE     E:\RBBS\
  417. ARENA10.ZIP    G:\FILES\6\
  418.  
  419. List of Files Found in the FMS but NOT Found on the Disk(s)
  420.  
  421. [ FileName ]---[ FMS Listing     ]--------------------------------------
  422. #2KEEN2.ZIP    C:\RBBS\DIRR\MASTER.DIR
  423. 123QB11.ZIP    C:\RBBS\DIRR\CHAIN91.DIR
  424. 174-NEW.ZIP    C:\RBBS\DIRR\MASTER.DIR
  425.  
  426.  
  427. List of Duplicate Files Found on the Disk(s)
  428.  
  429. [ FileName ]---[ Path One ]--------------------[ Path Two ]-------------
  430.  
  431.  
  432. List of Duplicate Entries in your File Listing
  433.  
  434. [ FileName ]---[ Path One ]--------------------[ Path Two ]-------------
  435. 174-NEW.ZIP    C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\DIRR\MASTER.DIR
  436. 174-NEW.ZIP    C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\PRIV\PRIV.DEF
  437. 174DOCWP.ZIP   C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\PRIV\PRIV.DEF
  438. ALIAS174.ZIP   C:\RBBS\DIRR\MASTER.DIR         C:\RBBS\PRIV\PRIV.DEF
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.                                    -7-
  459. ╓───────────────────────────────────────────────────────────────────────╖
  460. ║                                APPENDIX                               ║
  461. ╙───────────────────────────────────────────────────────────────────────╜
  462.  
  463.  
  464. If you uncover  a problem with  the operation of  this program please
  465. contact the author using one of the following methods.
  466.  
  467.    1)  BBS     - The GreyHawk BBS  Node 1 (410)461-9943 USR DS V.32Bis
  468.                                    Node 2 (410)465-3891 USR DS V.32Bis
  469.  
  470.    2)  USPS    - Walter C. Ames
  471.                  3126 Wheaton Way
  472.                  Ellicott City, MD 21043
  473.  
  474.    3)  NetMail - RelayNet ->GREYHAWK  R/O Capable
  475.                  FidoNet 1:261/1116 or 1:261/1117
  476.                  RBBSNet 8:936/203  or 8:936/204
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.                                    -8-
  515.